home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_2 / kme / kme.readme < prev    next >
Text File  |  1992-05-21  |  5KB  |  157 lines
  1.  
  2.                   ›32;43m                              ›0m
  3.                   ›32;43m           KME  V1.2          ›0m
  4.                   ›32;43m  © 1992 by Christian Stiens  ›0m
  5.                   ›32;43m          User Manual         ›0m
  6.                   ›32;43m                              ›0m
  7.  
  8.  
  9. ›1mIntroduction›0m
  10.  
  11. KME stands for "KeyMapEditor". It is a program with that you can edit the
  12. keymaps stored in DEVS:keymaps, which you can load with the "Setmap" command.
  13.  
  14.  
  15. ›1mCopyright›0m
  16.  
  17. © Copyright 1992 by   Christian Stiens
  18.                       Heustiege 2
  19.                       W-4710 Lüdinghausen
  20.                       GERMANY
  21.  
  22. The whole package (KME, docs and source) is Freeware.
  23.  
  24.     ***********************************************************
  25.     *                                                         *
  26.     * Distribution of the ›4mcomplete›0m and ›4munchanged›0m package is   *
  27.     * allowed only via noncommercial BBS's and on the         *
  28.     * following public domain disk series:                    *
  29.     *                                                         *
  30.     *                - Fred Fisk Amiga Lib Disks              *
  31.     *                - AMOK  (Amiga Modula & Oberon Club)     *
  32.     *                - Kickstart  (by Maxon, Germany)         *
  33.     *                                                         *
  34.     ***********************************************************
  35.  
  36. Usage of this program is at your own risk. There is no liability or
  37. responsibility for any damage caused by this program.
  38.  
  39. All Rights Reserved.
  40.  
  41.  
  42. ›1mRequirements›0m
  43.  
  44. KME was testet under Kickstart 1.3 and 2.04. If you are running under 1.3
  45. or lower, you must have the arp.library in LIBS: for the filerequester.
  46. You should also have topaz 80 as default font, if you don't have OS 2.0,
  47. otherways the string gadgets look a bit strange.
  48.  
  49.  
  50. ›1mManual›0m
  51.  
  52. KME can be started via Workbench or CLI.
  53.  
  54. In the upper half of the KME window you see the keyboard. You can select
  55. a key by clicking on it with your mouse or by pressing the key on your
  56. keyboard.
  57.  
  58. On the right hand side of the window you find 8 string gadgets. They contain
  59. the strings which the actual key sends when he is pressed together with the
  60. corresponding qualifiers indicated on the left side of the gadgets.
  61.  
  62. The OS 2.0 tabCycle feature is supported. So you can move to the next
  63. gadget by pressing the tab key and go to the previous by pressing shift-tab.
  64.  
  65. You can put in special control codes by preceding them a backslash:
  66.  
  67.     \n      Line-feed         ($0A)
  68.     \t      Tabulator         ($09)
  69.     \f      Form-feed         ($0C)
  70.     \r      Carriage-return   ($0D)
  71.     \b      Backspace         ($08)
  72.     \e      Escape            ($1B)
  73.     \[      CSI               ($9B)
  74.     \\      the backslash     ("\")
  75.     \xHH    the char with ascii code $HH
  76.  
  77. On the left side you see 5 rows with boolean gadgets which I now describe:
  78.  
  79. ›32mThe action gadgets:›0m
  80.  
  81.   LOAD:
  82.     The filerequester appears and you can select a keymap you want to modify.
  83.     Be sure not to load other executables than keymaps. KME can't check
  84.     if the file is a keymap, because there is no id in keymaps like in fonts.
  85.     The machine could crash if you load a executable that's not a keymap,
  86.     but I haven't tried.
  87.  
  88.   SAVE:
  89.     Again the filerequester appears and you can select a name for your
  90.     modified keymap to be saved.
  91.  
  92.   ABOUT:
  93.     Shows the information requester.
  94.  
  95.   QUIT:
  96.     Lets you quit the program after safety requester.
  97.  
  98.   ICONIFY:
  99.     Press this button if you want to leave KME for a while. The KME window
  100.     is reactivated by double clicking the icon.
  101.  
  102.   UNDO:
  103.     This takes back the changes that you have done with the actual key.
  104.  
  105.  
  106. ›32mThe parameter gadgets:›0m
  107.  
  108.   SHIFT, ALT, CONTROL:
  109.     This flags defines, which qualifiers are valid for the actual key.
  110.     There is a specialty for vanilla keys (keys with SHIFT, ALT, CONTROL
  111.     flag set, but DEAD and STRING flag unset):
  112.     The control-code for this kind of keys is made by clearing bits 5 and 6
  113.     of the char.
  114.  
  115.   DOWNUP:
  116.     Maybe this flag will work under Kickstart 3.0 ?!?  :-)
  117.  
  118.   DEAD:
  119.     If your key is a deadkey then you must set this flag. On the right
  120.     side of the string gadgets you can see 8 little gadgets. By clicking
  121.     on those gadgets you cycle through the 3 states "DEAD", "MOD" and none.
  122.     IF "DEAD" is set, then the string gadget contains the dead key code
  123.     i.e. an offset to the deadkey table. IF "MOD" is set, then the string
  124.     gadget holds the deadkey table, i.e. a field with 6 characters.
  125.     For the character "a" e.g. the deadkey table looks like "aáàâãä".
  126.     Only the german keymap uses an 18 char long deadkey table, therefore
  127.     the german keymap can work with double deadkeys, that means by pressing
  128.     <apostoph> <shift-apostroph> <o> you get "ô".
  129.  
  130.   STRING:
  131.     The actual key can send a string instead of only one char, if this
  132.     flag is set.
  133.  
  134.   NOP:
  135.     If this flag is set, no character is send when the key is pressed.
  136.  
  137.   CAPSABLE:
  138.     Keys with this flag set are capsable. That means they can be shifted
  139.     be the caps lock key.
  140.  
  141.   REPEATABLE:
  142.     This flag defines, wether the key repeat function is enabled for
  143.     the key.
  144.  
  145.  
  146. ›1mNote›0m
  147.  
  148. If you want to load in the modified keymap with "SetMap", you must keep in
  149. mind, that "SetMap" wont load the map if there is a map with same name
  150. in memory.
  151.  
  152.  
  153. ›3;32mMuch fun!›0m
  154.  
  155. --- Chris
  156.  
  157.